fix(demo): use bracketed admonition title syntax for Docusaurus 3.10#1445
Merged
Conversation
Docusaurus 3.10's strict admonition parser silently drops the box when the title uses the legacy space-separated form (`:::info TIP`). Switch to the bracketed form (`:::info[TIP]`) in versioning.mdx, sidebars.mdx, and the cos OpenAPI spec. Generated .api.mdx files already pick up the matching plugin-side fix from PR #1423 on regeneration.
|
Size Change: 0 B Total Size: 2.26 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 90b0919): https://docusaurus-openapi-36b86--pr1445-oitxsgwl.web.app (expires Fri, 08 May 2026 19:31:56 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docusaurus 3.10's strict admonition parser silently fails to render admonitions when the title uses the legacy space-separated form (e.g., `:::info TIP`). Affected admonitions render as plain text on the rendered page.
PR #1423 already fixed the plugin-side helper that emits the deprecated-operation notice. This PR cleans up the remaining hand-authored sources:
Generated `*.api.mdx` files are git-ignored and will pick up the bracketed form on the next `yarn gen-all`.
Test plan